.. include:: ../variables.rst .. _custom.audit.sessions: Custom Audit Sessions ===================== Every time someone completes one of your :ref:`custom audits` — a survey, checklist, or inspection you built — the result is saved here as a *session*. This page is where you review those completed sessions, check their scores, record a review decision, and remove sessions you no longer need. To open the list, go to :blue:`Audits` | :blue:`Custom Audit Sessions` in the sidebar. The entry appears only when Custom Audits are enabled for your account. .. figure:: /images/PLACEHOLDER-custom-audit-sessions-list.png :align: center TODO screenshot: the Custom Audit Sessions list with stat chips, filter toolbar, and a few scored sessions. |br| Starting a New Audit -------------------- Click ``Start Custom Audit`` in the page header to begin a new audit. A search panel opens listing every audit currently available to your account. * Type in the ``Search audits...`` box to narrow the list by audit name or category. * Each entry shows the audit name with its category and question count beneath it. * Click an audit to launch it. |APPNAME| opens the survey so it can be completed; when it is submitted, the result returns to this list as a new session. Filtering the List ------------------ The toolbar lets you narrow the list to the sessions you care about: * ``Search by audit name, auditor, or session ID...`` — match text in the audit name, the person who submitted it, or the session identifier. * ``All Statuses`` — show only ``Draft``, ``Submitted``, ``Approved``, or ``Rejected`` sessions. * ``All Results`` — show only sessions that ``Passed`` or ``Failed``. * ``All Audits`` — scope to a single audit. * ``All Auditors`` — scope to the person who submitted the session. * ``All Follow Up`` — show only sessions that do (``Required``) or do not (``Not Required``) need follow-up. Click the refresh icon to reload the list without losing your filter selections. Stat Chips ^^^^^^^^^^ Cards across the top give you an instant rollup of the filtered list: * ``Total Sessions`` — every session matching the current filters. * ``Approved`` — sessions you have marked approved. * ``Pending Review`` — submitted sessions still waiting for a review decision. * ``Avg Score`` — the average score across the scored sessions in the list. * ``Pass`` — scored sessions that met their passing threshold. * ``Fail`` — scored sessions that did not. * ``Follow Up`` — sessions flagged as needing follow-up. Session Row ^^^^^^^^^^^ Each row summarizes one completed audit: * ``Audit`` — the audit name, with the session identifier beneath it. Click it, or choose ``View Details``, to open the session. * ``Auditor`` — the person who submitted the session. * ``Score`` — a progress bar and percentage, with the points earned out of the maximum beneath it. Sessions that are not scored show ``N/A``. * ``Result`` — a ``Pass`` or ``Fail`` badge. A session still in draft shows a dash until it is submitted. * ``Status`` — the review state: ``Draft``, ``Submitted``, ``Approved``, or ``Rejected``. * ``Follow Up`` — a flag icon when the session needs follow-up. * ``Date`` — when the audit was recorded. * ``Duration`` — how long the audit took to complete. .. note:: The badges on each row are for display only. To change a session's review status, use ``Approve`` or ``Reject`` on the row menu described below. Session Row Menu ^^^^^^^^^^^^^^^^ Click the three-dot icon at the end of any row: * ``View Details`` — opens the full session, where you can see every answer the auditor recorded. * ``Approve`` — records an approved review decision for the session. * ``Reject`` — records a rejected review decision for the session. * ``Delete`` — permanently removes the session after a confirmation prompt. The row menu is available only to users with permission to manage audit sessions. Selecting Multiple Sessions ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Tick the checkbox on one or more rows to reveal the bulk action bar, then click ``Delete Selected`` to remove every ticked session in one step. The ``x`` button clears the selection without deleting anything.